Retrieve Orders

Request to retrieve order details in a WS API version-neutral format (version neutral with respect to the WS API version the order (initial transaction) was submitted in) for transactions that have been created in the gateway within a defined start and end date/time.

You can limit the result list to orders that

have last been updated after a defined start date/time and before a defined end date/time and
contain one or more specified fields.

To define the result set, use the predicate query parameter in the URL. For details refer to order reports integration documentation.

For a successful request, the response will contain a list of orders that match the criteria defined in the predicate query parameter. Where no order(s) match the criteria defined in the predicate, the response will be empty.

The response contains

the order details in the WS API version-neutral format,
the details for all transactions for the order in the WS API version-neutral format, and
the complete RETRIEVE_ORDER response as returned to the merchant when retrieving the order via the merchant WS API.

By default the response will contain all fields, however you can use the fields parameter in the request to limit which order, transaction and API fields are provided in the response.

By default the response will contain all transactions for each order, however you can use the transactionPredicate parameter in the request to limit the response to transactions that match a defined criteria.

For details refer to order reports integration documentation.

Note:

Provide your Reporting API credentials to access this operation.
The orders in the result set are not ordered.
The response provides a content length and MD5 check sum in the standard fields.

GET https://na.gateway.spring.citi.com/api/rest/version/57 / mso / {msoId} / order

Authentication

This operation requires authentication via one of the following methods:

Certificate authentication.
Basic HTTP authentication as described at w3.org. Provide 'MSO.<your gateway MSO ID>' in the userid portion and your Reporting API password in the password portion.

Request

URL Parameters

{msoId} Alphanumeric + additional characters REQUIRED

The identifier that uniquely identifies you or an MSO that has authorized you to use this operation on their behalf.

Data may consist of the characters 0-9, a-z, A-Z, '-', '_', ' ', '&', '+', '!', '$', '%', '.'

Min length: 1 Max length: 16

Fields Show optional fields

To view the optional fields, please toggle on the "Show optional fields" setting.

correlationId String OPTIONAL

A transient identifier for the request, that can be used to match the response to the request.

The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.

Data can consist of any characters

Min length: 1 Max length: 100

fields JSON Text OPTIONAL

By default the response contains all order, transaction and API fields.

Use this parameter to limit the response to only the fields listed.

For a full description refer to order reports integration documentation.

Data is valid Json Format

Min length: 1 Max length: 2048

iterator Alphanumeric + additional characters REQUIRED

For a response with a large number of orders the response to your Retrieve Orders request only returns a subset of orders and an iterator (field iterator in the HTTP header).

Use the iterator in a subsequent request to retrieve the next set of orders in the result set.

Where all orders have been provided, the response will not contain an iterator.

For the full result set, combine the subsets of all responses for all iterators.

When providing an iterator you do not need to provide a predicate.

Data may consist of the characters 0-9, a-z, A-Z, '_', '-'

Min length: 1 Max length: 2048

predicate JSON Text REQUIRED

The predicate allows you to define which orders you would like to retrieve.

For a full description of the predicate structure and supported fields, see order reports integration documentation.

When providing a predicate you do not need to provide an iterator.

Data is valid Json Format

Min length: 1 Max length: 2048

transactionPredicate JSON Text OPTIONAL

By default the response contains all transactions for the order.

Use this parameter to limit which transactions should be included in the response.

For a full description of the transactionPredicate structure and supported fields see order reports integration documentation.

Data is valid Json Format

Min length: 1 Max length: 2048

Response

Fields Show conditional fields

To view the conditional fields, please toggle on the "Show conditional fields" setting.

3dsAuthenticationStatus Enumeration CONDITIONAL

The payer authentication status for this order.

For example, payer authentication performed using 3DS version 1, EMV 3DS, or RuPay PaySecure.

Value must be a member of the following list. The values are case sensitive.

AUTHENTICATION_ATTEMPTED

Payer authentication was attempted and a proof of authentication attempt was obtained.

AUTHENTICATION_AVAILABLE

Payer authentication is available for the payment method provided, but has not yet been performed.

AUTHENTICATION_EXEMPT

An exemption from the Regulatory Technical Standards (RTS) requirements for Strong Customer Authentication (SCA) under the Payment Services Directive 2 (PSD2) regulations in the European Economic Area has been claimed or granted.

AUTHENTICATION_FAILED

The payer was not authenticated. The merchant should not proceed with this transaction.

AUTHENTICATION_NOT_AVAILABLE

The payer was not able to be authenticated due to a technical or other issue.

AUTHENTICATION_NOT_IN_EFFECT

There is no authentication information associated with this transaction.

AUTHENTICATION_NOT_SUPPORTED

The requested authentication method is not supported for this payment method.

AUTHENTICATION_PENDING

Payer authentication is pending completion of a challenge process.

AUTHENTICATION_PROCESSING_ERROR

Payer authentication could not be performed because of a processing error.

AUTHENTICATION_REJECTED

The payment method provider (for example, the card issuer) rejected the authentication request and requested that the merchant does not attempt authorization of a payment.

AUTHENTICATION_REQUIRED

Payer authentication is required for this payment, but was not provided.

AUTHENTICATION_SUCCESSFUL

The payer was successfully authenticated.

3dsEci String CONDITIONAL

The Electronic Commerce Indicator (ECI) for the order, as returned by the issuer in the 3-D Secure Authentication response.

The ECI is an indicator for the authentication result and liability shift.

3dsEnrollmentStatus Enumeration CONDITIONAL

An indicator for the card used for this order being enrolled in 3-D Secure Authentication.

Value must be a member of the following list. The values are case sensitive.

AUTHENTICATION_AVAILABLE

Payer authentication is available for the payment method provided, but has not yet been performed.

AUTHENTICATION_EXEMPT

AUTHENTICATION_NOT_SUPPORTED

The requested authentication method is not supported for this payment method.

AUTHENTICATION_PENDING

Payer authentication is pending completion of a challenge process.

AUTHENTICATION_REJECTED

The payment method provider (for example, the card issuer) rejected the authentication request and requested that the merchant does not attempt authorization of a payment.

AUTHENTICATION_REQUIRED

Payer authentication is required for this payment, but was not provided.

ENROLLED

The card is enrolled for 3-D Secure Authentication.

ENROLLMENT_PROCESSING_ERROR

An error occurred when attempting to determine if the card is enrolled for 3-D Secure Authentication.

ENROLLMENT_UNDETERMINED

The card issuer's Access Control Server (ACS) was unable to process the request to determine if the card is enrolled for 3-D Secure Authentication.

NOT_ENROLLED

The card is not enrolled for 3-D Secure Authentication.

accountHolder String CONDITIONAL

The name of the account holder for the account used to pay for the order.

Depending on the payment type, this can for example be the name of the card or the name registered with a PayPal account or a bank account.

accountIdentifier String CONDITIONAL

The identifier of the account used by the payer to pay for this order.

Depending on the payment type, this can for example be a card number, PayPal email address or bank identifier and account number.

accountIdentifierEntryPoint Enumeration CONDITIONAL

The way by which the account identifier used for this order entered the gateway.

For example, transaction details were provided in a batch file. This matches the PCI boundary for the gateway.

Value must be a member of the following list. The values are case sensitive.

BATCH

The account identifier was provided by the merchant in a request submitted within a Batch.

CHECKOUT

The account identifier was provided by the payer on a Checkout page provided by the gateway. The Checkout page was launched from the merchant's website.

CLIENT_API

The account identifier was provided in a request submitted by the merchant via a client-side API, for example, Payment Client.

EXTERNAL_TOKEN

The account identifier was provided by providing a token issued by an external token provider.

GATEWAY_TOKEN

The account identifier was provided by providing a token issued by the gateway.

NOT_PROVIDED

No information is available about how the account identifier entered the gateway.

PHYSICAL_TERMINAL

The account identifier was provided by the payer at a physical terminal, for example, a POS terminal or PED.

SERVER_API

The account identifier was provided by the merchant in a request submitted via a server-side API, for example, Web Service API or a 2-Party VPC integration.

SERVICE_PROVIDER_API

The account identifier was imported into the gateway by a service provider using an API provided

VIRTUAL_TERMINAL

The account identifier was provided by the merchant when creating the order via virtial terminal, for example Merchant Administration.

WALLET

The account identifier was provided by the payer using a wallet, for example, MasterPass.

accountIdentifierPresentation Enumeration CONDITIONAL

The way by which the account identifier was entered for Card Present transactions.

Value must be a member of the following list. The values are case sensitive.

CONTACT

The card details were read from a card that was inserted into a PED, e.g. Chip read and PIN entered by payer.

CONTACTLESS

The card details were read via a contactless payment at a PED.

KEYED

The merchant keyed the card details into a PED.

SCANNED

The card details were scanned, for example via a OCR/MICR code reader.

SWIPED

The card was swiped at a PED.

UNKNOWN

It is unknown how the card details were entered.

achSecCode Enumeration CONDITIONAL

The Standard Entry Class (SEC) code as defined by NACHA, describing the origin and intent of the payment.

For details refer to https://www.nacha.org/.

Value must be a member of the following list. The values are case sensitive.

ARC

An ACH Debit entry based on a paper check remitted by US Mail or a drop box and converted into an electronic payment. May be used for B2C and B2B payments.

BOC

An ACH Debit entry created when a paper check written at point of sale and converted into an electronic payment through back office processing. May be used for B2C and B2B payments.

CCD

An ACH Debit or ACH Credit entry created by an organization for B2B payments. The customer authorizes the organization to make a debit or credit transaction against their account.

POP

An ACH Debit entry based on a paper check presented at the point of purchase. The paper check is used solely as a source document for routing and account number information. The merchant voids the paper check and returns it to the customer along with a POP receipt. Used for B2C and B2B payments.

PPD

An ACH debit or credit payment (B2C) that has been authorized by an authenticated customer in written form (signed or similarly authenticated). PPD is used for pre-arranged payments (e.g. employee payroll, mortgage payments, expense reimbursement).

RCK

An ACH Debit entry used to re-present a paper check that was originally unpaid. For example, when the check was originally presented insufficient funds were in the account or the account had uncollected (inaccessible) funds.

TEL

An ACH debit payment (B2C) that has been authorized by an authenticated customer via phone. TEL may only be used if a relationship already exists between the merchant and the consumer, or, the consumer initiates the contact with the merchant.

WEB

An ACH debit payment (B2C) that has been authorized by an authenticated customer via the internet or a wireless network.

agreementId String CONDITIONAL

An identifier for the agreement between the merchant and the payer that allows the merchant to process a series of payments without the payer's involvement.

For example, recurring payments or account top up.

agreementType Enumeration CONDITIONAL

The type of agreement between the merchant and the payer that allows the merchant to process a series of payments without the payer's involvement.

For example, recurring payments or account top up.

Value must be a member of the following list. The values are case sensitive.

INSTALLMENT

An agreement where the payer authorizes the payment for a single purchase to be split into a number of payments processed at agreed intervals. For example, pay for a purchase in six monthly installments.

OTHER

An agreement where the merchant wants to link related payments for any purpose other than processing recurring, installment, or unscheduled payments. For example, split tender payments.

RECURRING

An agreement where the payer authorizes the merchant to process payments for recurring bills or invoices at agreed intervals (for example, weekly, monthly). The amount might be fixed or variable.

UNSCHEDULED

An agreement where the payer authorizes the merchant to automatically deduct funds for a payment for an agreed purchase when required (unscheduled). For example, auto top-ups when the account value falls below a threshold.

bankAccountType Enumeration CONDITIONAL

The type of the bank account used for this payment, e.g. Savings or Checking.

Value must be a member of the following list. The values are case sensitive.

CHECKING

The payer has selected a Checking account.

CORPORATE_CHECKING

The payer has selected a Corporate Checking account.

SAVINGS

The payer has selected a Savings account.

bankIdentifierInternational String CONDITIONAL

The internationally recognized identifier for the payer's bank (also known as Bank Identifier Code or BIC).

bankIdentifierNational String CONDITIONAL

The identifier for the payer's bank as used in that country.

billingAddressCity String CONDITIONAL

The city portion of the billing address.

billingAddressCompany String CONDITIONAL

The name of the company associated with this billing address.

billingAddressCountry Enumeration CONDITIONAL

The 3-character (alphanumeric) ISO country code of the billing address.

Value must be a member of the following list. The values are case sensitive.

ABW

AFG

AGO

AIA

ALA

ALB

AND

ARE

ARG

ARM

ASM

ATA

ATF

ATG

AUS

AUT

AZE

BDI

BEL

BEN

BES

BFA

BGD

BGR

BHR

BHS

BIH

BLM

BLR

BLZ

BMU

BOL

BRA

BRB

BRN

BTN

BVT

BWA

CAF

CAN

CCK

CHE

CHL

CHN

CIV

CMR

COD

COG

COK

COL

COM

CPV

CRI

CUB

CUW

CXR

CYM

CYP

CZE

DEU

DJI

DMA

DNK

DOM

DZA

ECU

EGY

ERI

ESH

ESP

EST

ETH

FIN

FJI

FLK

FRA

FRO

FSM

GAB

GBR

GEO

GGY

GHA

GIB

GIN

GLP

GMB

GNB

GNQ

GRC

GRD

GRL

GTM

GUF

GUM

GUY

HKG

HMD

HND

HRV

HTI

HUN

IDN

IMN

IND

IOT

IRL

IRN

IRQ

ISL

ISR

ITA

JAM

JEY

JOR

JPN

KAZ

KEN

KGZ

KHM

KIR

KNA

KOR

KWT

LAO

LBN

LBR

LBY

LCA

LIE

LKA

LSO

LTU

LUX

LVA

MAC

MAF

MAR

MCO

MDA

MDG

MDV

MEX

MHL

MKD

MLI

MLT

MMR

MNE

MNG

MNP

MOZ

MRT

MSR

MTQ

MUS

MWI

MYS

MYT

NAM

NCL

NER

NFK

NGA

NIC

NIU

NLD

NOR

NPL

NRU

NZL

OMN

PAK

PAN

PCN

PER

PHL

PLW

PNG

POL

PRI

PRK

PRT

PRY

PSE

PYF

QAT

REU

ROU

RUS

RWA

SAU

SDN

SEN

SGP

SGS

SHN

SJM

SLB

SLE

SLV

SMR

SOM

SPM

SRB

SSD

STP

SUR

SVK

SVN

SWE

SWZ

SXM

SYC

SYR

TCA

TCD

TGO

THA

TJK

TKL

TKM

TLS

TON

TTO

TUN

TUR

TUV

TWN

TZA

UGA

UKR

UMI

URY

USA

UZB

VAT

VCT

VEN

VGB

VIR

VNM

VUT

WLF

WSM

YEM

ZAF

ZMB

ZWE

billingAddressPostcodeZIP String CONDITIONAL

The post code or zip code of the billing address.

billingAddressStateProvince String CONDITIONAL

The state or province of the billing address.

billingAddressStreet String CONDITIONAL

The street name and number, or the Post Office Box details of the billing address.

cardEncryption Enumeration CONDITIONAL

The method of encryption used for the card number, as received by the gateway.

Value must be a member of the following list. The values are case sensitive.

DEVICE

A device encrypted the payment details.

DIGITAL_WALLET

A digital wallet encrypted the payment details.

DUKPT

Derived Unique Key Per Transaction (DUKPT)

cardExpiryDate String CONDITIONAL

The expiry date for the card as printed on the card in the format MM/YY.

cardFundingMethod Enumeration CONDITIONAL

The method used by the payer to provide the funds for a card payment, e.g. Credit or Debit.

Value must be a member of the following list. The values are case sensitive.

CREDIT

The payer has a revolving line of credit with the issuer.

DEBIT

Funds are immediately debited from the payer's account with the issuer.

UNKNOWN

The account funding method could not be determined by the gateway.

correlationId String CONDITIONAL

A transient identifier for the request, that can be used to match the response to the request.

The value provided is not validated, does not persist in the gateway, and is returned as provided in the response to the request.

dccOfferUptakeByPayer Enumeration CONDITIONAL

Indicates how Dynamic Currency Conversion (DCC) was used for this order.

For example, offer accepted or offer declined.

Value must be a member of the following list. The values are case sensitive.

ACCEPTED

DCC was offered to the payer and the payer accepted the offer and is paying in the currency of their card (instead of the currency of the transaction). The conditions of the DCC offer are applied in the processing of this transaction.

DECLINED

DCC was offered to the payer but the payer declined the offer and is paying in the currency of the transaction.

NOT_AVAILABLE

DCC was not offered to the payer. However, a DCC rate quote was requested for this payment, but no DCC offer was provided by the DCC provider.

NOT_REQUIRED

DCC is not required for this transaction.

dccPayerAmount Money CONDITIONAL

The order amount in the payer's currency when Dynamic Currency Conversion (DCC) was used to convert the amount to the merchant's currency at the point of sale.

The field includes both the amount and currency.

dccPayerExchangeRate Numeric CONDITIONAL

The exchange rate used to convert the merchant amount (in the merchant's currency) into the payer's currency when Dynamic Currency Conversion (DCC) was used at the point of sale.

This rate includes the foreign exchange markup.

dccProvider Enumeration CONDITIONAL

The name of the Dynamic Currency Conversion (DCC) provider that provided the DCC rate quote.

Value must be a member of the following list. The values are case sensitive.

FEXCO

The FEXCO Dynamic Currency Conversion (DCC) provider.

FTT

The FTT Dynamic Currency Conversion (DCC) provider.

GLOBAL_PAYMENTS

The Global Payments Dynamic Currency Conversion (DCC) provider.

IBM

The IBM Dynamic Currency Conversion (DCC) provider.

TRAVELEX_CURRENCY_SELECT

The Travelex Currency Select Dynamic Currency Conversion (DCC) provider.

UNICREDIT

The Unicredit Dynamic Currency Conversion (DCC) provider.

item[n] Array CONDITIONAL

item[n].brand String CONDITIONAL

The brand of the item.

For example, Dell.

item[n].category String CONDITIONAL

The category of the item.

For example, computers.

item[n].description String CONDITIONAL

A description for the item with information such as size, color, etc.

For example, 'Color:Red, Size:M'.

item[n].name String CONDITIONAL

A short name describing the item.

item[n].quantity Numeric CONDITIONAL

The quantity of the item.

item[n].sku String CONDITIONAL

The SKU (Stock Keeping Unit) or the item identifier for this item.

item[n].unitPrice Money CONDITIONAL

The cost price for the item.

This amount is multiplied with item.quantity to determine the total amount for this item. The field includes both the amount and currency.

item[n].unitTaxAmount Money CONDITIONAL

The tax amount for the item.

This amount is multiplied with item.quantity to determine the total tax amount for this item. The field includes both the amount and currency.

merchantAmount Money CONDITIONAL

The amount of the order in the currency the merchant uses for their inventory.

If there is Foreign Exchange (FX) on this order, this is based on the rate quote applied by the merchant for this order. In all other cases this is the order amount.

merchantCategoryCode String CONDITIONAL

The Merchant Category Code (MCC, also known as Bank Industry Code) used to classify the merchant's business by the type of goods or services it offers.

merchantId String CONDITIONAL

The unique identifier of the merchant that has submitted this order for processing by the gateway.

merchantOrderReference String CONDITIONAL

The merchant's reference for this order if it differs from the unique order ID used by the gateway.

For example, when the merchant supports multiple payments on a single order, rolls their order identifier or where the order ID is provided by an alternate system. For example, the system used by the sub-merchant of an aggregator. This identifier may not be unique for all orders for the merchant in the gateway.

orderAccountIdentifierProxy String CONDITIONAL

A value that uniquely identifies the account identifier for an order.

It can be used as a proxy to match orders with the same account identifier, when the unmasked account identifier is not available (e.g. for PCI reasons).

orderAirlineBookingReference String CONDITIONAL

The record locator used to access a specific Passenger Name Record (PNR).

The PNR is a record in the database of a booking system that contains the itinerary for a passenger, or a group of passengers traveling together.

orderAirlineLeg[n] Array CONDITIONAL

orderAirlineLeg[n].carrierCode String CONDITIONAL

The 2-character IATA airline code or 3 digit accounting code or both of the airline carrier for the trip leg.

orderAirlineLeg[n].conjunctionTicketNumber String CONDITIONAL

The ticket containing the coupon for this leg for an itinerary with more than four trip legs.

orderAirlineLeg[n].couponNumber String CONDITIONAL

The coupon number on the ticket for the trip leg.

Each trip leg requires a separate coupon. The coupon within the series is identified by the coupon number.

orderAirlineLeg[n].departureAirport String CONDITIONAL

The 3-character IATA airport code of the departure airport for the trip leg.

orderAirlineLeg[n].departureDate Date CONDITIONAL

The date of departure for the trip leg.

orderAirlineLeg[n].departureTime Time CONDITIONAL

The departure time in local time for the departure airport for this trip leg.

orderAirlineLeg[n].destinationAirport String CONDITIONAL

The 3-character IATA airport code for the destination airport for the trip leg.

orderAirlineLeg[n].destinationArrivalDate Date CONDITIONAL

The arrival date in local time for the destination airport for this trip leg

orderAirlineLeg[n].destinationArrivalTime Time CONDITIONAL

The arrival time in local time for the destination airport for this trip leg.

orderAirlineLeg[n].endorsementsRestrictions String CONDITIONAL

The restrictions (e.g. non-refundable) or endorsements applicable to the trip leg.

orderAirlineLeg[n].exchangeTicketNumber String CONDITIONAL

The new ticket number issued when a ticket is exchanged for the trip leg.

orderAirlineLeg[n].fare Money CONDITIONAL

The total fare payable for the trip leg.

orderAirlineLeg[n].fareBasis String CONDITIONAL

The code defining the rules forming the basis of the fare (type of fare, class entitlement, etc.)

orderAirlineLeg[n].fees Money CONDITIONAL

The total fees payable for the trip leg.

orderAirlineLeg[n].flightNumber String CONDITIONAL

The flight number for the trip leg

orderAirlineLeg[n].stopoverPermitted Boolean CONDITIONAL

An indicator if a stopover is permitted for the trip leg.

orderAirlineLeg[n].taxes Money CONDITIONAL

The total amount of taxes payable for the trip leg.

orderAirlineLeg[n].travelClass String CONDITIONAL

The industry code indicating the class of service (e.g. Business, Coach) for the leg.

orderAirlinePassenger[n] Array CONDITIONAL

orderAirlinePassenger[n].frequentFlyerNumber String CONDITIONAL

The Frequent Flyer or Loyalty Program number for this passenger.

orderAirlinePassenger[n].name String CONDITIONAL

The name of the passenger to whom the ticket is being issued, including the title, first, middle and last name.

orderAirlineTicketIssueDate Date CONDITIONAL

The date the ticket was issued.

orderAirlineTicketIssueTravelAgentCode String CONDITIONAL

The industry code of the travel agent issuing the ticket.

orderAirlineTicketNumber String CONDITIONAL

The airline ticket number associated with the order.

orderAmount Money CONDITIONAL

The total amount of the order as presented to the payer.

For partially approved orders this amount matches the approved Authorization amount. The field includes both the amount and currency.

orderAuthenticationType Enumeration CONDITIONAL

The type of authentication performed for the order.

For example 3DS version 1, EMV 3DS, or RuPay PaySecure.

Value must be a member of the following list. The values are case sensitive.

3DS1

The payer has been authenticated using 3-D Secure Authentication Version 1.

EMV_3DS

The payer has been authenticated using EMV 3DS (also called 3-D Secure Authentication Version 2.0)

NONE

Payer Authentication has not been performed for this order.

RUPAY_PAYSECURE

The payer has been authenticated using RuPay PaySecure.

orderCashbackAmount Money CONDITIONAL

The cashback amount for the order.

The field includes both the amount and currency.

orderChargebackAmount Money CONDITIONAL

The total amount that has been successfully debited from the merchant's account as a result of chargebacks against this order.

The field includes both the amount and currency.

orderCreationDate Datetime CONDITIONAL

The date and time when the order was created in the gateway.

orderDescription String CONDITIONAL

A short textual description of the content of the order.

orderDiscountAmount Money CONDITIONAL

The total amount of the discount applied to this order.

The field includes both the amount and currency.

orderDiscountCode String CONDITIONAL

The code used by the merchant to identify the reason for the discount.

orderDiscountDescription String CONDITIONAL

A textual description of the reason for the discount.

orderFundingAmount Money CONDITIONAL

The total amount of money funded to / from the merchant's bank account for this order, as reported to the gateway by the acquirer.

This includes sales (credits to your account) and refunds (debits). The field includes both the amount and currency.

orderFundingStatus Enumeration CONDITIONAL

The current status of funding for the money that the merchant can reasonably expect for this order.

It reflects both money into and out of the merchant's bank account (that is, both sales and refunds). When considering funding status, the gateway only examines transactions that can move funds. For example, it ignores Authorizations and declined Captures. This is because fundingStatus reflects the movement of the money for the commercial transaction, it does not reflect the movement of money for fees associated with the transaction. The funding status does not take into account any fees charged to merchant.

Value must be a member of the following list. The values are case sensitive.

FUNDED

All transactions that could transfer money to / from the merchant's account, have now settled.

FUNDING_ASSURED

All transactions that could transfer money to / from the merchant's account, are guaranteed to settle, but have not yet done so. The exact amount of the funds to be transferred might not be known in this state.

FUNDING_FAILED

There are transactions on the order that could result in the transfer of money to / from your account, however the service provider has not yet received funds from the payer. In case of an order with a refund the service provider was not able to transfer funds to the payer.

FUNDING_ON_HOLD

There are transactions on the order that could result in the transfer of money to / from your account, however the service provider is unable to complete the transfer of funds. This might be a transient state.

IN_PROGRESS

There are transactions on the order that could result in the transfer of money to / from the merchant's account, but some have not yet have done so. This is usually a transient state.

NON_FUNDED

There are no transactions on the order that could result in transfer of money to / from the merchant's account.

NOT_SUPPORTED

All transactions on the order were settled to a payment provider from which the gateway does not receive funding information.

orderGratuityAmount Money CONDITIONAL

The gratuity/tip amount for the order.

The field includes both the amount and currency.

orderId String CONDITIONAL

The unique identifier for this order.

orderItemAmount Money CONDITIONAL

The total item amount for the order.

The field includes both the amount and currency.

orderLastUpdatedDate Datetime CONDITIONAL

The date and time when the order was last updated in the gateway.

orderNetAmount Money CONDITIONAL

The amount payable for the order before surcharging is applied.

The field includes both the amount and currency.

orderNetworkTokenProvider Enumeration CONDITIONAL

The token service provider that issued the network token, if a network token was used for this order.

Value must be a member of the following list. The values are case sensitive.

AETS

American Express Token Service

MDES

Mastercard Digital Enablement Service

VTS

Visa Token Service

orderOutstandingAuthorizationAmount Money CONDITIONAL

The amount that has been successfully authorized but not yet captured for this order.

The field includes both the amount and currency.

orderRequestedAmount Money CONDITIONAL

The requested order amount, if and only if the inital transaction for the order was only partially approved.

In this case the order amount is set to the actually approved amount. The field includes both the amount and currency.

orderRequestorName String CONDITIONAL

The name of the person who requested the goods or services.

orderShippingAndHandlingAmount Money CONDITIONAL

The total shipping and handling amount for the order.

The field includes both the amount and currency.

orderStatus Enumeration CONDITIONAL

A quick summary of the progress of the order, for example, if the order has successfully been authorized, captured and/or refunded.

Value must be a member of the following list. The values are case sensitive.

AUTHENTICATED

The payer was successfully authenticated.

AUTHENTICATION_INITIATED

Payer authentication has been initiated but not completed.

AUTHENTICATION_NOT_NEEDED

Payer authentication was not performed as it was not needed.

AUTHENTICATION_UNSUCCESSFUL

Payer authentication was not able to be successfully completed.

AUTHORIZED

The payment for this order has been authorized successfully but the authorized amount has not yet been captured, in part, full, or excess.

CANCELLED

The initial transaction for this order has been voided successfully.

CAPTURED

The authorized amount for this order, in full or excess, has been captured successfully.

CHARGEBACK_PROCESSED

The order was disputed by the payer, and a chargeback has occurred, i.e. the funds have been returned to the payer.

DISPUTED

The order is currently in dispute and may require further action by the merchant. For example, additional information about the order has been requested by the service provider.

EXCESSIVELY_REFUNDED

The payment for this order has been captured in part, full, or excess, but the captured amount in excess has been refunded successfully.

FAILED

The payment for this order has not been successful.

FUNDING

The order transfers money to or from the merchant, without the involvement of a payer. For example, recording monthly merchant service fees from the payment service provider.

INITIATED

A payment has successfully been initiated for this order. However, no payment has yet been made.

ON_HOLD

The order is currently on hold and requires further action by the merchant. For example, a refund against the captured amount on this order has been requested but not yet executed. Further action is required to approve the requested refund.

PARTIALLY_CAPTURED

The authorized amount for this order, in part, has been captured successfully.

PARTIALLY_REFUNDED

The payment for this order has been captured in part, full, or excess, but the captured amount in part has been refunded successfully.

REFUNDED

The payment for this order has been captured in part, full, or excess, but the captured amount in full has been refunded successfully.

VERIFIED

The payment details for this order have successfully been verified. No payment has yet been initiated or made.

orderSurchargeAmount Money CONDITIONAL

The surcharge amount for the order.

The field includes both the amount and currency.

orderSurchargeSource Enumeration CONDITIONAL

Indicates how the surcharge amount was determined for an order.

Value must be a member of the following list. The values are case sensitive.

CLIENT

The surcharge amount was provided by the merchant.

GATEWAY

The surcharge amount was calculated by the gateway based on surcharging rules configured by the merchant.

orderTax[n] Array CONDITIONAL

orderTax[n].amount Money CONDITIONAL

The amount for this type of tax, when a breakdown of the types of taxes and amount per type of tax for the order are provided.

The field includes both the amount and currency.

orderTax[n].type String CONDITIONAL

The name or code for this type of tax, when a breakdown of the types of taxes and amount per type of tax for the order are provided.

orderTaxAmount Money CONDITIONAL

The total tax amount for the order.

The field includes both the amount and currency.

orderTotalAuthorizedAmount Money CONDITIONAL

The amount that has been successfully authorized for this order.

The field includes both the amount and currency.

orderTotalCapturedAmount Money CONDITIONAL

The amount that has been successfully captured for this order.

The field includes both the amount and currency.

orderTotalRefundedAmount Money CONDITIONAL

The amount that has been successfully refunded for this order.

The field includes both the amount and currency.

payerBrowser String CONDITIONAL

The User-Agent header of the browser the payer used to place the order.

For example, MOZILLA/4.0 (COMPATIBLE; MSIE 5.0; WINDOWS 95).

payerEmail String CONDITIONAL

The email address of the payer (person) who placed the order.

payerIpAddress String CONDITIONAL

The IP address of the computer used by the payer, in nnn.nnn.nnn.nnn format.

payerMobilePhone String CONDITIONAL

The mobile phone or cell phone number of the payer (person) who placed the order.

payerName String CONDITIONAL

The name of the payer (person) who placed the order.

payerOrderDate Date CONDITIONAL

The date the payer placed this order.

payerOrderNote String CONDITIONAL

The payer's note for this order.

payerOrderReference String CONDITIONAL

The payer's reference to this order.

For example, the Purchase Order Number.

payerPhone String CONDITIONAL

The phone number of the payer (person) who placed the order.

paymentLocation String CONDITIONAL

The bank or location where the payer completed this payment.

For example, the store location, the ATM location, and/or the terminal identifier. When you map to this field, you could choose to concatenate location and terminal identifier (for example: <bankLocation> : <terminalIdentifier>).

paymentPlanDeferralNumberOfMonths Numeric CONDITIONAL

The number of months for which the (first) payment is deferred.

paymentPlanId String CONDITIONAL

The gateway's identifier for the payment plan, for example PLANN, PLANAMEX, CIELO.

paymentPlanInstallmentAmount Money CONDITIONAL

The amount for each instalment to be made on this payment plan, excluding the initial payment.

The field includes both the amount and currency.

paymentPlanInterestRate Numeric CONDITIONAL

The interest rate applied to the order amount.

paymentPlanNumberOfInstallments Numeric CONDITIONAL

The number of payments the payer has to make on this payment plan.

paymentPlanTotalAmount Money CONDITIONAL

The total amount payable on this payment plan, including any interest.

The field includes both the amount and currency.

retrieveOrderApiResponse JSON Text CONDITIONAL

The response returned to the merchant when they retrieve this order using the WS API RETRIEVE_ORDER operation.

This response is provided in the WS API version used by the merchant when submitting the first transaction for this order for processing via the gateway.

Response parameters are the same as Transaction: Retrieve Order. Note that the link refers to the latest API version.

Data is valid Json Format

Min length: 1 Max length: 50000

riskAssessmentResult Enumeration CONDITIONAL

The overall result of the risk assessment for the order.

Value must be a member of the following list. The values are case sensitive.

ACCEPTED

The order was risk assessed and accepted.

NOT_ASSESSED

The order was not risk assessed, apart from the system risk rules and these did not reject the order.

REJECTED

The order was risk assessed and rejected.

REVIEW_REQUIRED

The order was risk assessed and requires a review.

riskReviewDecisionNote String CONDITIONAL

The reason selected and/or note entered by the merchant when reviewing the order or overriding the risk assessment decision.

riskReviewDecisionStatus Enumeration CONDITIONAL

The status of the risk review for this order as performed by the merchant.

Value must be a member of the following list. The values are case sensitive.

ACCEPTED

The order did require a risk review and has been accepted.

NOT_REQUIRED

The order did not require a risk review.

OVERRIDDEN

The order has been rejected by the Risk Service Provider and subsequently accepted by the merchant.

PENDING

The order requires a risk review and is pending a risk review decision.

REJECTED

The order did require a risk review and has been rejected.

riskReviewDecisionTime Datetime CONDITIONAL

The date and time the merchant reviewed the order, if the order was flagged for review as a result of the risk assessment.

riskReviewDecisionUserId String CONDITIONAL

The user ID of the person that reviewed the order when the order was flagged for review by the merchant as a result of risk assessment.

riskRule[n] Array CONDITIONAL

riskRule[n].description String CONDITIONAL

A string that contains details about the risk rule triggered, including e.g. an identifier for the rule plus the data the rule applied to.

riskRule[n].outcome String CONDITIONAL

The score or recommendation determined for the order after applying this risk rule.

riskTotalRiskScore Numeric CONDITIONAL

The total of the risk scores for all risk rules applied when assessing the risk for the order being fraudulent.

shippingAddressCity String CONDITIONAL

The city portion of the shipping address.

shippingAddressCompany String CONDITIONAL

The name of the company associated with this shipping address.

shippingAddressCountry Enumeration CONDITIONAL

The 3 letter ISO standard alpha country code of the shipping address.

Value must be a member of the following list. The values are case sensitive.

ABW

AFG

AGO

AIA

ALA

ALB

AND

ARE

ARG

ARM

ASM

ATA

ATF

ATG

AUS

AUT

AZE

BDI

BEL

BEN

BES

BFA

BGD

BGR

BHR

BHS

BIH

BLM

BLR

BLZ

BMU

BOL

BRA

BRB

BRN

BTN

BVT

BWA

CAF

CAN

CCK

CHE

CHL

CHN

CIV

CMR

COD

COG

COK

COL

COM

CPV

CRI

CUB

CUW

CXR

CYM

CYP

CZE

DEU

DJI

DMA

DNK

DOM

DZA

ECU

EGY

ERI

ESH

ESP

EST

ETH

FIN

FJI

FLK

FRA

FRO

FSM

GAB

GBR

GEO

GGY

GHA

GIB

GIN

GLP

GMB

GNB

GNQ

GRC

GRD

GRL

GTM

GUF

GUM

GUY

HKG

HMD

HND

HRV

HTI

HUN

IDN

IMN

IND

IOT

IRL

IRN

IRQ

ISL

ISR

ITA

JAM

JEY

JOR

JPN

KAZ

KEN

KGZ

KHM

KIR

KNA

KOR

KWT

LAO

LBN

LBR

LBY

LCA

LIE

LKA

LSO

LTU

LUX

LVA

MAC

MAF

MAR

MCO

MDA

MDG

MDV

MEX

MHL

MKD

MLI

MLT

MMR

MNE

MNG

MNP

MOZ

MRT

MSR

MTQ

MUS

MWI

MYS

MYT

NAM

NCL

NER

NFK

NGA

NIC

NIU

NLD

NOR

NPL

NRU

NZL

OMN

PAK

PAN

PCN

PER

PHL

PLW

PNG

POL

PRI

PRK

PRT

PRY

PSE

PYF

QAT

REU

ROU

RUS

RWA

SAU

SDN

SEN

SGP

SGS

SHN

SJM

SLB

SLE

SLV

SMR

SOM

SPM

SRB

SSD

STP

SUR

SVK

SVN

SWE

SWZ

SXM

SYC

SYR

TCA

TCD

TGO

THA

TJK

TKL

TKM

TLS

TON

TTO

TUN

TUR

TUV

TWN

TZA

UGA

UKR

UMI

URY

USA

UZB

VAT

VCT

VEN

VGB

VIR

VNM

VUT

WLF

WSM

YEM

ZAF

ZMB

ZWE

shippingAddressEmail String CONDITIONAL

The email address of the person to whom the order is being shipped.

shippingAddressMobilePhone String CONDITIONAL

The mobile phone or cell phone number of the person to whom the order is being shipped.

shippingAddressName String CONDITIONAL

The name of the person to whom the order is being shipped.

shippingAddressPhone String CONDITIONAL

The phone number of the person to whom the order is being shipped.

shippingAddressPostcodeZIP String CONDITIONAL

The post code or zip code of the shipping address.

shippingAddressStateProvince String CONDITIONAL

The state or province of the shipping address.

shippingAddressStreet String CONDITIONAL

The street name and number, or the Post Office Box details of the shipping address.

subMerchantId String CONDITIONAL

The aggregator's identifier for the sub-merchant.

subMerchantMerchantCategoryCode String CONDITIONAL

The Merchant Category Code (MCC, also known as Bank Industry Code) describing the type of business the sub-merchant operates in.

subMerchantTradingName String CONDITIONAL

The trading name of the sub merchant, also known as Doing Business As (DBA), Operating As or Trading As.

token String CONDITIONAL

The token that has been provided for this order and used by the gateway to retrieve all or some of the payment details (stored against the token) used for this order.

transaction[n] Array CONDITIONAL

transaction[n].acquirerBatchNumber String CONDITIONAL

The ID of the acquirer settlement batch that contains the transaction.

transaction[n].acquirerId String CONDITIONAL

The unique identifier of the acquirer that has been used to process this transaction.

Which acquirer is used to process a transaction is determined by the gateway based on the merchant acquirer links configured for the merchant.

transaction[n].acquirerMerchantId String CONDITIONAL

The Acquirer Merchant Identifier (also known as Card Acceptor Identification Code or CAIC) allocated to the merchant by the acquirer.

transaction[n].acquirerResponseCode String CONDITIONAL

The transaction processing response code (indicating the success or otherwise of the transaction) as provided by the aqcuirer or other provider, for example, PayPal, ACH, Sofortbanking.

transaction[n].acquirerResponseMessage String CONDITIONAL

The textual description of the response code that indicates the result of the transaction as provided by the acquirer or other provider, for example, PayPal, ACH, Sofortbanking.

transaction[n].acquirerSettlementDate Date CONDITIONAL

The date the acquirer expects the funds to be transferred to (in the case of payments) or from (in the case of refunds) the merchant's account.

The date is defined in the acquirer's time zone (see acquirerTimeZone).

transaction[n].acquirerTerminalId String CONDITIONAL

The terminal configured at the acquirer used to process the transaction (as provided by the acquirer).

transaction[n].acquirerTimeZone String CONDITIONAL

The acquirer's time zone associated with the settlement date for the transaction (see acquirerSettlementDate).

transaction[n].acquirerTransactionId String CONDITIONAL

The identifier used in the communication between the merchant and the acquirer to identify the transaction.

For example, this could be the RRN, the order ID or an identifier issued by the gateway (often based on the merchant ID, order ID and/or transaction ID). The acquirer may, for example, use this identifier in Settlement Reports for card payments or Exception Detail Reports for ACH.

transaction[n].airlineBookingReference String CONDITIONAL

The record locator used to access a specific Passenger Name Record (PNR).

The PNR is a record in the database of a booking system that contains the itinerary for a passenger, or a group of passengers traveling together.

transaction[n].airlineLeg[n] Array CONDITIONAL

transaction[n].airlineLeg[n].carrierCode String CONDITIONAL

The 2-character IATA airline code of the airline carrier for the trip leg.

transaction[n].airlineLeg[n].conjunctionTicketNumber String CONDITIONAL

The ticket containing the coupon for this leg for an itinerary with more than four trip legs.

transaction[n].airlineLeg[n].couponNumber String CONDITIONAL

The coupon number on the ticket for the trip leg.

Each trip leg requires a separate coupon. The coupon within the series is identified by the coupon number.

transaction[n].airlineLeg[n].departureAirport String CONDITIONAL

The 3-character IATA airport code of the departure airport for the trip leg.

transaction[n].airlineLeg[n].departureDate Date CONDITIONAL

The date of departure for the trip leg.

transaction[n].airlineLeg[n].departureTime Time CONDITIONAL

The departure time in local time for the departure airport for this trip leg.

transaction[n].airlineLeg[n].destinationAirport String CONDITIONAL

The 3-character IATA airport code for the destination airport for the trip leg.

transaction[n].airlineLeg[n].destinationArrivalDate Date CONDITIONAL

The arrival date in local time for the destination airport for this trip leg

transaction[n].airlineLeg[n].destinationArrivalTime Time CONDITIONAL

The arrival time in local time for the destination airport for this trip leg.

transaction[n].airlineLeg[n].endorsementsRestrictions String CONDITIONAL

The restrictions (e.g. non-refundable) or endorsements applicable to the trip leg.

transaction[n].airlineLeg[n].exchangeTicketNumber String CONDITIONAL

The new ticket number issued when a ticket is exchanged for the trip leg.

transaction[n].airlineLeg[n].fare Money CONDITIONAL

The total fare payable for the trip leg.

The field includes both the amount and currency.

transaction[n].airlineLeg[n].fareBasis String CONDITIONAL

The code defining the rules forming the basis of the fare (type of fare, class entitlement, etc.)

transaction[n].airlineLeg[n].fees Money CONDITIONAL

The total fees payable for the trip leg.

The field includes both the amount and currency.

transaction[n].airlineLeg[n].flightNumber String CONDITIONAL

The flight number for the trip leg

transaction[n].airlineLeg[n].stopoverPermitted Boolean CONDITIONAL

An indicator if a stopover is permitted for the trip leg.

transaction[n].airlineLeg[n].taxes Money CONDITIONAL

The total amount of taxes payable for the trip leg.

The field includes both the amount and currency.

transaction[n].airlineLeg[n].travelClass String CONDITIONAL

The industry code indicating the class of service (e.g. Business, Coach) for the leg.

transaction[n].airlinePassenger[n] Array CONDITIONAL

transaction[n].airlinePassenger[n].frequentFlyerNumber String CONDITIONAL

The Frequent Flyer or Loyalty Program number for this passenger.

transaction[n].airlinePassenger[n].name String CONDITIONAL

The name of the passenger to whom the ticket is being issued, including the title, first, middle and last name.

transaction[n].airlineTicketIssueDate Date CONDITIONAL

The date the ticket was issued.

transaction[n].airlineTicketIssueTravelAgentCode String CONDITIONAL

The industry code of the travel agent issuing the ticket.

transaction[n].airlineTicketNumber String CONDITIONAL

The airline ticket number associated with the transaction.

transaction[n].authorizationCode String CONDITIONAL

A value generated by the issuing bank for a successful Authorization request.

This value must be provided when submitting subsequent Capture transactions to the acquirer to identify the Authorization.

transaction[n].avsAcquirerResponseCode String CONDITIONAL

A response code for the Address Verification Service (AVS) result generated by the card issuing institution as provided by the acquirer.

transaction[n].avsGatewayResponseCode Enumeration CONDITIONAL

A response code for the Address Verification Service (AVS) validation result generated by the gateway indicating whether the billing address details provided by the payer matched the billing address details held by the cardholder's issuing bank.

Value must be a member of the following list. The values are case sensitive.

MATCH

The address details provided matched with the address details at the issuer.

NOT_VERIFIED

The address details provided were not verfied.

NO_MATCH

None of the address details provided matched with the address details at the issuer.

PARTIAL_MATCH

Some of the address details provided matched with the address details at the issuer.

transaction[n].cscAcquirerResponseCode String CONDITIONAL

A response code for the Card Security Code (CSC) validation result generated by the card issuing institution as provided by the acquirer.

transaction[n].cscGatewayResponseCode Enumeration CONDITIONAL

A response code for the Card Security Code (CSC) validation result generated by the gateway indicating whether the CSC provided by the payer matched the CSC data held by the cardholder's issuing bank.

Value must be a member of the following list. The values are case sensitive.

MATCH

The Card Security Code (CSC) provided is valid and matches the one on the card.

NOT_PRESENT

The merchant indicated that no Card Security Code (CSC) was present on the card.

NOT_VERIFIED

The Card Security Code (CSC) provided was not verified.

NO_MATCH

The Card Security Code (CSC) provided is either invalid or did not match the one on the card.

transaction[n].dataModel Enumeration CONDITIONAL

The format used to represent the transaction as understood by the merchant.

For example, Web Service.

Value must be a member of the following list. The values are case sensitive.

FLEXIBLE_FORMAT

The transaction was provided in the FlexibleFormat format.

VPC_M

The transaction was provided in the VPC-M format.

VPC_T

The transaction was provided in the VPC-T format.

WEB_SERVICE

The transaction was provided in the WebService format.

transaction[n].disputeDeadlineDate Date CONDITIONAL

The date before which necessary action needs to be taken by the merchant to avoid funds from being debited from their account for a disptuted transaction.

transaction[n].disputeEvent Enumeration CONDITIONAL

The step in the dispute management process that triggered this transaction.

Value must be a member of the following list. The values are case sensitive.

ACTION_REQUIRED

An action from the merchant is required.

CHARGEBACK_DEBITED

The chargeback amount will soon be debited to the merchant's account.

CHARGEBACK_PENDING

The chargeback amount will soon be debited to the merchant's account. The merchant should ensure there are sufficient funds in the account.

CHARGEBACK_REVERSED

The chargeback amount that was previously debited has been credited back to the merchant's account.

INFORMATION_ONLY

Information about the status of the dispute is provided.

INFORMATION_RECEIVED

The acquirer has received information requested from the merchant.

INFORMATION_REQUESTED

The issuer has requested additional information about a disputed transaction.

RECURRING_PAYMENT_CANCELLED

The payer has disputed a recurring payment transaction and it is cancelled. For example, the recurring payment amount was more than agreed.

transaction[n].disputeEventDate Date CONDITIONAL

The date of the event in the dispute management process described by transaction.dispute.event.

transaction[n].disputeEventInformation String CONDITIONAL

Additional information about the dispute event.

The terms used here will reflect the terms used by the acquiring bank.

transaction[n].disputeReason String CONDITIONAL

A description of why the transaction is disputed.

transaction[n].disputeReasonCode String CONDITIONAL

The code provided by the acquirer to indicate the reason for the chargeback.

transaction[n].disputeRecurringPaymentCancelledDate Date CONDITIONAL

The date the payer notified the issuer to cancel a recurring payment that is being disputed.

transaction[n].gatewayResponseCode Enumeration CONDITIONAL

The code generated by the gateway that provides more details for a payment where the result indicates that a failure occurred during processing of the transaction.

Value must be a member of the following list. The values are case sensitive.

APPROVED

The transaction has been approved.

AUTHENTICATION_IN_PROGRESS

The operation determined that payer authentication is possible for the given card, but this has not been completed, and requires further action by the merchant to proceed.

BLOCKED

The transaction has been blocked as a result of a risk assessment.

CANCELLED

The transaction has been cancelled by the payer.

DECLINED_HARD

The transaction has been declined by the issuer, acquirer or other Payment Service Provider. The merchant must ask the payer for another set of payment details.

DECLINED_SOFT

The transaction has been declined by the issuer, acquirer or other Payment Service Provider. The problem might be resolved by retrying the request later (e.g. for insufficient funds the merchant may contact the payer and retry once the payer has indicated that fundsa r now available).

NOT_SUPPORTED

The transaction request could not be processed. Reasons include the requested functionality not being supported by the acquirer, missing request fields that are mandatory for the acquirer, and failed acquirer-specific validation. A later retry will not succeed.

PARTIALLY_APPROVED

The transaction has been approved, however the approved transaction amount differs from the requested transaction amount.

PENDING_RESPONSE

The gateway has not yet received a response from the acquirer or other Payment Service Provider (e.g. PayPal) about the status of the transaction.

PENDING_SETTLEMENT

The gateway has accepted the transaction and either has not yet submitted it to the acquirer for settlement, submitted it to the acquirer for settlement but has not yet received a response from the acquirer, or has received a response from the acquirer but not yet updated the status of the transaction.

PROCESSING_ERROR

The transaction could not be processed, as a technical error occurred during processing of the transaction. This includes acquirer system errors, gateway internal errors, connectivity issues etc. A later retry attempt may succeed.

REFERRED

The transaction has been delined and the merchant is asked to contact the issuer. The issuer may provide the merchant with an Authorization Code that will allow the merchant to subsequently capture the funds for the transaction.

UNSPECIFIED_FAILURE

The transaction request could not be processed. The gateway does not know if the transaction was successful or not. Reasons include merchant requests that cannot be processed due to a gateway internal error, the gateway being unable to retrieve a response from the acquirer (after exhausting all retry or reversal attempts), and a response from the acquirer that is not understood by the gateway. The merchant needs to contact their acquirer.

transaction[n].merchantBatchName String CONDITIONAL

The name of the batch file, uploaded by the merchant to the gateway, that contains this transaction.

transaction[n].merchantId String CONDITIONAL

The unique identifier of the merchant that has submitted this order for processing by the gateway.

transaction[n].merchantOrderReference String CONDITIONAL

The merchant's reference for this order if it differs from the unique order ID used by the gateway.

transaction[n].merchantTransactionSource Enumeration CONDITIONAL

Indicates the channel through which the transaction was initiated by the payer, for example, Internet or Card Present.

Value must be a member of the following list. The values are case sensitive.

CARD_PRESENT

The payer initiated the order in a scenario where the payment instrument (e.g. the credit card) was physically presented.

INTERNET

The payer initiated the order via the Internet. This applies to online orders and all e-commerce scenarios.

MERCHANT

The merchant initiated the order based on an agreement with the payer.

MOTO

The payer initiated the order by mail or telephone, including Call Center interactions.

PAYER_PRESENT

Transaction where a non-card payment method is presented to the merchant.

SCHEDULED

The payment is a scheduled payment that was triggered by a recurring payment agreement between the payer and the merchant.

SERVICE_PROVIDER

The transaction was provided by a service provider (e.g. chargeback, funding).

VOICE_RESPONSE

The payer initiated the order via an Interactive Voice Response (IVR) system.

transaction[n].multiCurrencyPricingMerchantAmount Money CONDITIONAL

The amount of the transaction in the currency the merchant uses for their inventory.

This is typically derived from the rate quote and the payer amount for the transaction.

transaction[n].multiCurrencyPricingProviderData String CONDITIONAL

Additional data of interest to the Multi-Currency Pricing (MCP) service provider.

transaction[n].orderId String CONDITIONAL

The unique identifier for this order.

transaction[n].recurringPaymentAcquirerResponseCode String CONDITIONAL

DEPRECATED This code may be returned by the acquirer for a failed recurring transaction (also known as Merchant Advice Code or Recurring Payment Advice Cancellation.

transaction[n].recurringPaymentGatewayResponseCode Enumeration CONDITIONAL

DEPRECATED The response code generated by the gateway to indicate what action you should take for a failed recurring transaction.

A value can be provided if the information is provided by the acquirer.

Value must be a member of the following list. The values are case sensitive.

OBTAIN_NEW_ACCOUNT_INFORMATION

The merchant may attempt this transaction again with updated account information. This may indicate for example that the card has expired, that the account has been upgraded or a new card number has been issued.

SEEK_OTHER_PAYMENT_METHOD

The merchant must not attempt this transaction again. This payer may wish to continue with the recurring payment agreement, however, the merchant must obtain another source for this payment from the payer.

STOP_RECURRING_PAYMENT

The merchant must not attempt this transaction again. The payer has requested that this payment, all recurring payments for the merchant, or all recurring payments for this card are stopped.

TRY_AGAIN_LATER

The merchant may attempt this transaction again (with same account information).

transaction[n].rrn String CONDITIONAL

The gateway's unique identifier for the transaction provided to the acquirer.

Also called Reference Retrieval Number (RRN).

transaction[n].stan String CONDITIONAL

The System Trace Audit Number (STAN) assigned by the gateway to assist in identifying the transaction when communicating with the acquirer.

It remains unchanged for the life of the transaction.

transaction[n].transaction3dsAuthenticationStatus Enumeration CONDITIONAL

The payer authentication status for this transaction.

For example, payer authentication performed using 3DS version 1, EMV 3DS, or RuPay PaySecure.

Value must be a member of the following list. The values are case sensitive.

AUTHENTICATION_ATTEMPTED

Payer authentication was attempted and a proof of authentication attempt was obtained.

AUTHENTICATION_AVAILABLE

Payer authentication is available for the payment method provided, but has not yet been performed.

AUTHENTICATION_EXEMPT

AUTHENTICATION_FAILED

The payer was not authenticated. The merchant should not proceed with this transaction.

AUTHENTICATION_NOT_AVAILABLE

The payer was not able to be authenticated due to a technical or other issue.

AUTHENTICATION_NOT_IN_EFFECT

There is no authentication information associated with this transaction.

AUTHENTICATION_NOT_SUPPORTED

The requested authentication method is not supported for this payment method.

AUTHENTICATION_PENDING

Payer authentication is pending completion of a challenge process.

AUTHENTICATION_PROCESSING_ERROR

Payer authentication could not be performed because of a processing error.

AUTHENTICATION_REJECTED

The payment method provider (for example, the card issuer) rejected the authentication request and requested that the merchant does not attempt authorization of a payment.

AUTHENTICATION_REQUIRED

Payer authentication is required for this payment, but was not provided.

AUTHENTICATION_SUCCESSFUL

The payer was successfully authenticated.

transaction[n].transaction3dsEci String CONDITIONAL

The Electronic Commerce Indicator (ECI) for the transaction, as returned by the issuer in the 3-D Secure Authentication response.

The ECI is an indicator for the authentication result and liability shift.

transaction[n].transaction3dsEnrollmentStatus Enumeration CONDITIONAL

An indicator for the card used for this transaction being enrolled in 3-D Secure Authentication.

Value must be a member of the following list. The values are case sensitive.

AUTHENTICATION_AVAILABLE

Payer authentication is available for the payment method provided, but has not yet been performed.

AUTHENTICATION_EXEMPT

AUTHENTICATION_NOT_SUPPORTED

The requested authentication method is not supported for this payment method.

AUTHENTICATION_PENDING

Payer authentication is pending completion of a challenge process.

AUTHENTICATION_REJECTED

The payment method provider (for example, the card issuer) rejected the authentication request and requested that the merchant does not attempt authorization of a payment.

AUTHENTICATION_REQUIRED

Payer authentication is required for this payment, but was not provided.

ENROLLED

The card is enrolled for 3-D Secure Authentication.

ENROLLMENT_PROCESSING_ERROR

An error occurred when attempting to determine if the card is enrolled for 3-D Secure Authentication.

ENROLLMENT_UNDETERMINED

The card issuer's Access Control Server (ACS) was unable to process the request to determine if the card is enrolled for 3-D Secure Authentication.

NOT_ENROLLED

The card is not enrolled for 3-D Secure Authentication.

transaction[n].transactionAccountHolder String CONDITIONAL

The name of the account holder for the account used to pay for the transaction.

Depending on the payment type, this can be the name of the card or the name registered with a PayPal account or a bank account.

transaction[n].transactionAccountIdentifier String CONDITIONAL

The identifier of the account used by the payer to pay for this transaction.

Depending on the payment type, this can be a card number, PayPal email address or bank identifier and account number.

transaction[n].transactionAccountIdentifierEntryPoint Enumeration CONDITIONAL

The way by which the account identifier used for this transaction entered the gateway.

For example, transaction details were provided in a batch file. This matches the PCI boundary for the gateway.

Value must be a member of the following list. The values are case sensitive.

BATCH

The account identifier was provided by the merchant in a request submitted within a Batch.

CHECKOUT

The account identifier was provided by the payer on a Checkout page provided by the gateway. The Checkout page was launched from the merchant's website.

CLIENT_API

The account identifier was provided in a request submitted by the merchant via a client-side API, for example, Payment Client.

EXTERNAL_TOKEN

The account identifier was provided by providing a token issued by an external token provider.

GATEWAY_TOKEN

The account identifier was provided by providing a token issued by the gateway.

NOT_PROVIDED

No information is available about how the account identifier entered the gateway.

PHYSICAL_TERMINAL

The account identifier was provided by the payer at a physical terminal, for example, a POS terminal or PED.

SERVER_API

The account identifier was provided by the merchant in a request submitted via a server-side API, for example, Web Service API or a 2-Party VPC integration.

SERVICE_PROVIDER_API

The account identifier was imported into the gateway by a service provider using an API provided

VIRTUAL_TERMINAL

The account identifier was provided by the merchant when creating the order via virtial terminal, for example Merchant Administration.

WALLET

The account identifier was provided by the payer using a wallet, for example, MasterPass.

transaction[n].transactionAccountIdentifierPresentation Enumeration CONDITIONAL

The way by which the account identifier was entered for Card Present transactions.

Value must be a member of the following list. The values are case sensitive.

CONTACT

The card details were read from a card that was inserted into a PED, e.g. Chip read and PIN entered by payer.

CONTACTLESS

The card details were read via a contactless payment at a PED.

KEYED

The merchant keyed the card details into a PED.

SCANNED

The card details were scanned, for example via a OCR/MICR code reader.

SWIPED

The card was swiped at a PED.

UNKNOWN

It is unknown how the card details were entered.

transaction[n].transactionAccountIdentifierProxy String CONDITIONAL

A value that uniquely identifies the account identifier for a transaction.

It can be used as a proxy to match transactions with the same account identifier, when the unmasked account identifier is not available (e.g. for PCI reasons).

transaction[n].transactionAchSecCode Enumeration CONDITIONAL

The Standard Entry Class (SEC) code as defined by NACHA, describing the origin and intent of the payment.

For details refer to https://www.nacha.org/.

Value must be a member of the following list. The values are case sensitive.

ARC

An ACH Debit entry based on a paper check remitted by US Mail or a drop box and converted into an electronic payment. May be used for B2C and B2B payments.

BOC

An ACH Debit entry created when a paper check written at point of sale and converted into an electronic payment through back office processing. May be used for B2C and B2B payments.

CCD

An ACH Debit or ACH Credit entry created by an organization for B2B payments. The customer authorizes the organization to make a debit or credit transaction against their account.

POP

PPD

RCK

TEL

WEB

An ACH debit payment (B2C) that has been authorized by an authenticated customer via the internet or a wireless network.

transaction[n].transactionAmount Money CONDITIONAL

The total amount for this transaction.

For a partially approved transaction this amount is the approved amount. The field includes both the amount and currency.

transaction[n].transactionAuthenticationType Enumeration CONDITIONAL

The type of authentication performed for the transaction.

For example 3DS version 1, EMV 3DS, or RuPay PaySecure.

Value must be a member of the following list. The values are case sensitive.

3DS1

The payer has been authenticated using 3-D Secure Authentication Version 1.

EMV_3DS

The payer has been authenticated using EMV 3DS (also called 3-D Secure Authentication Version 2.0)

NONE

Payer Authentication has not been performed for this order.

RUPAY_PAYSECURE

The payer has been authenticated using RuPay PaySecure.

transaction[n].transactionBankAccountType Enumeration CONDITIONAL

The type of the bank account used for this transaction, e.g. Savings or Checking.

Value must be a member of the following list. The values are case sensitive.

CHECKING

The payer has selected a Checking account.

CORPORATE_CHECKING

The payer has selected a Corporate Checking account.

SAVINGS

The payer has selected a Savings account.

transaction[n].transactionBankIdentifierInternational String CONDITIONAL

The internationally recognized identifier for the payer's bank (also known as Bank Identifier Code or BIC).

transaction[n].transactionBankIdentifierNational String CONDITIONAL

The identifier for the payer's bank as used in that country.

transaction[n].transactionCardEncryption Enumeration CONDITIONAL

The method of encryption used for the card number, as received by the gateway.

Value must be a member of the following list. The values are case sensitive.

DEVICE

A device encrypted the payment details.

DIGITAL_WALLET

A digital wallet encrypted the payment details.

DUKPT

Derived Unique Key Per Transaction (DUKPT)

transaction[n].transactionCardExpiryDate String CONDITIONAL

The expiry date for the card used for this transaction as printed on the card in the format MM/YY.

transaction[n].transactionCardFundingMethod Enumeration CONDITIONAL

The method used by the payer to provide the funds for the payment, e.g. Credit or Debit.

Value must be a member of the following list. The values are case sensitive.

CREDIT

The payer has a revolving line of credit with the issuer.

DEBIT

Funds are immediately debited from the payer's account with the issuer.

UNKNOWN

The account funding method could not be determined by the gateway.

transaction[n].transactionDccOfferUptakeByPayer Enumeration CONDITIONAL

Indicates how Dynamic Currency Conversion (DCC) was used for this transaction.

For example, offer accepted or offer declined.

Value must be a member of the following list. The values are case sensitive.

ACCEPTED

DECLINED

DCC was offered to the payer but the payer declined the offer and is paying in the currency of the transaction.

NOT_AVAILABLE

DCC was not offered to the payer. However, a DCC rate quote was requested for this payment, but no DCC offer was provided by the DCC provider.

NOT_REQUIRED

DCC is not required for this transaction.

transaction[n].transactionDccPayerAmount Money CONDITIONAL

The transaction amount in the payer's currency when Dynamic Currency Conversion (DCC) was used to convert the amount to the merchant's currency at the point of sale.

The field includes both the amount and currency.

transaction[n].transactionDccPayerExchangeRate Numeric CONDITIONAL

The exchange rate used to convert the transaction amount into the payer's currency.

This rate includes the foreign exchange markup.

transaction[n].transactionDccProvider Enumeration CONDITIONAL

The name of the Dynamic Currency Conversion (DCC) provider that provided the DCC rate quote.

Value must be a member of the following list. The values are case sensitive.

FEXCO

The FEXCO Dynamic Currency Conversion (DCC) provider.

FTT

The FTT Dynamic Currency Conversion (DCC) provider.

GLOBAL_PAYMENTS

The Global Payments Dynamic Currency Conversion (DCC) provider.

IBM

The IBM Dynamic Currency Conversion (DCC) provider.

TRAVELEX_CURRENCY_SELECT

The Travelex Currency Select Dynamic Currency Conversion (DCC) provider.

UNICREDIT

The Unicredit Dynamic Currency Conversion (DCC) provider.

transaction[n].transactionFeeAmount Money CONDITIONAL

The total fee amount debited from the merchant's bank account for the transaction as reported to the gateway by the acquirer.

The field includes both the amount and currency.

transaction[n].transactionFrequency Enumeration CONDITIONAL

Indicates where this transaction occurs within a sequence of payments agreed between the payer and the merchant.

For example, an installment payment, a one-off payment, or a recurring payment.

Value must be a member of the following list. The values are case sensitive.

INSTALLMENT

A transaction where the payer has authorized the merchant to deduct an agreed number of installments.

OTHER

A transaction where the payer has authorized the merchant to deduct funds for a payment, for any purpose other than processing recurring, installment, or unscheduled payments. For example, split tender payments.

RECURRING

A transaction where the payer has authorized the merchant for recurring payments, e.g. subscriptions or recurring invoices for services.

SINGLE

A transaction where the payer has authorized the merchant for a single (one off) payment. This value is also used for the first payment in a series of recurring or installment payments.

UNSCHEDULED

A transaction where the payer has authorized the merchant to deduct funds for a payment for an agreed purchase when required (unscheduled). For example, auto top-ups when the account value falls below a threshold.

transaction[n].transactionFunding[n] Array CONDITIONAL

transaction[n].transactionFunding[n].acquirerFeeName String CONDITIONAL

The fee name as provided by the service provider.

transaction[n].transactionFunding[n].feeAmount Money CONDITIONAL

The fee amount charged to the merchant for the given fee type.

The field includes both the amount and currency.

transaction[n].transactionFunding[n].feeDate Date CONDITIONAL

The date the fees are debited from the merchant's bank account (defined in the acquirer's time zone).

This value is only populated if the date is known with certainty.

transaction[n].transactionFunding[n].feeEstimatedDate Date CONDITIONAL

The date the acquirer estimates that the fees are being debited from the merchant's bank account (defined in the acquirer's time zone).

This value is only populated if neither the initiated date nor the actual date the funds are debited are available.

transaction[n].transactionFunding[n].feeInitiatedDate Date CONDITIONAL

The date the acquirer estimates that the fees are being debited from the merchant's bank account (defined in the acquirer's time zone).

This value is only populated if neither the initiated date nor the actual date the funds are debited are available.

transaction[n].transactionFunding[n].feeRate String CONDITIONAL

The rate (percentage) applied to the transaction amount to determine the fee amount charged to the merchant for the given fee type.

transaction[n].transactionFunding[n].feeType Enumeration CONDITIONAL

The gateway category for the fee that has been charged to the merchant.

Value must be a member of the following list. The values are case sensitive.

CHARGEBACK_FEE

Fees associated with Chargeback transactions.

FUNDING_FEE

Fees associated with transferring the money into the merchant's account.

MERCHANT_FEE

Fees associated with the merchant account. For example: Merchant monthly fee, Minimum monthly fee

OTHER_FEE

Any other fees that have not been captured by the above types.

TRANSACTION_FEE

Fees associated with Authorization, Capture and Refund transactions.

transaction[n].transactionFundingAcquirerEventDescription String CONDITIONAL

The acquirer's description for the Funding event.

Provides additional information regarding the event that has resulted in movement of funds from/to the merchant bank account.

transaction[n].transactionFundingAmount Money CONDITIONAL

The total amount that has been succesfully credited or debited to the merchant's bank account for this transaction as reported to the gateway by the acquirer.

This may be a credit (positive value) or debit (negative value). The field includes both the amount and currency.

transaction[n].transactionFundingDate Date CONDITIONAL

The date the funds arrive in the merchant's bank account (defined in the acquirer's time zone).

This value is only populated if the date is known with certainty.

transaction[n].transactionFundingEstimatedDate Date CONDITIONAL

The date the acquirer estimates the funds to arrive in the merchant's bank account (defined in the acquirer's time zone).

This value is only populated if neither the initiated date nor the actual funding date are available.

transaction[n].transactionFundingInitiatedDate Date CONDITIONAL

The date the acquirer initiated the funds transfer into the merchant's bank account (defined in the acquirer's time zone).

This value is only populated if the date of transfer is known with certainty, but the date the funds will settle to the merchant's account is uncertain.

transaction[n].transactionFundingSettlementIdentifier String CONDITIONAL

The service providers identifier for the group of transactions settled to merchant account.

transaction[n].transactionFundingStatus Enumeration CONDITIONAL

The current status of funding for the money the merchant can reasonably expect from their service provider for this transaction.

It reflects both money into and out of the merchant's bank account (that is, both sales and refunds).The funding status does not take into account any fees charged to merchant.

Value must be a member of the following list. The values are case sensitive.

FUNDED

The transaction is clearing and will move money into the merchant's account.

FUNDING_ADJUSTED

Funding for the transaction has been adjusted, meaning either funds have been to / from your account. This can happen for both successful or failed funding.

FUNDING_ASSURED

The transaction is guaranteed to settle, but has not yet done so.

FUNDING_FAILED

The transaction could result in the transfer of money to / from your account, however the service provider has not yet received funds from the payer. In case of a refund the service provider was not able to transfer funds to the payer.

FUNDING_ON_HOLD

The transaction could result in the transfer of money to / from your account, however the financial provider is unable to complete the transfer of funds. This might be a transient state.

IN_PROGRESS

The transaction could result in the transfer of money to / from the merchant's account, but has not yet done so. This is usually a transient state.

NON_FUNDED

The transaction cannot result in transfer of money to / from the merchant's account.

NOT_SUPPORTED

The transaction was settled to an institution from which the gateway does not receive funding information.

transaction[n].transactionId String CONDITIONAL

The unique identifier for this transaction that distinguishes it from any other transactions on the order.

transaction[n].transactionItem[n] Array CONDITIONAL

transaction[n].transactionItem[n].brand String CONDITIONAL

The brand of the item.

For example, Dell.

transaction[n].transactionItem[n].category String CONDITIONAL

The category of the item.

For example, computers.

transaction[n].transactionItem[n].description String CONDITIONAL

A description for the item with information such as size, color, etc.

For example, 'Color:Red, Size:M'.

transaction[n].transactionItem[n].name String CONDITIONAL

A short name describing the item.

transaction[n].transactionItem[n].quantity Numeric CONDITIONAL

The quantity of the item.

transaction[n].transactionItem[n].sku String CONDITIONAL

The SKU (Stock Keeping Unit) or the item identifier for this item.

transaction[n].transactionItem[n].unitPrice Money CONDITIONAL

The cost price for the item.

This amount is multiplied with item.quantity to determine the total amount for this item. The field includes both the amount and currency.

transaction[n].transactionItem[n].unitTaxAmount Money CONDITIONAL

The tax amount for the item.

This amount is multiplied with item.quantity to determine the total tax amount for this item. The field includes both the amount and currency.

transaction[n].transactionLastUpdatedDate Datetime CONDITIONAL

The date and time when the transaction was last updated in the gateway.

transaction[n].transactionMerchantNote String CONDITIONAL

A note for the transaction, provided by the merchant.

transaction[n].transactionNetworkTokenProvider Enumeration CONDITIONAL

The token service provider that issued the network token, if a network token was used for this transaction.

Value must be a member of the following list. The values are case sensitive.

AETS

American Express Token Service

MDES

Mastercard Digital Enablement Service

VTS

Visa Token Service

transaction[n].transactionPaymentLocation String CONDITIONAL

The bank or location where the payer completed this payment.

transaction[n].transactionPaymentMethod[n] Array Enumeration CONDITIONAL

The payment method the payer has chosen for this transaction.

Value must be a member of the following list. The values are case sensitive.

ACH

The payer chose to pay using an electronic fund transfer, to be processed via the Automated Clearing House (ACH) Network.

ALIPAY

The payer chose to pay using Alipay.

AMERICAN_EXPRESS

The payer chose to pay using an American Express credit or debit card.

BANAMEX_COSTCO

The payer chose to pay using a Banamex Costco card.

BANCANET

The payer chose to pay using the Banamex online banking (BancaNet).

BANKAXEPT

The payer chose to pay using BankAxept.

BED_BATH_AND_BEYOND

The payer chose to pay using a Bed, Bath & Beyond card.

BOLETO_BANCARIO

The payer chose to pay using Boleto Bancario.

CARNET

The payer chose to pay using a Carnet card.

CARTE_BANCAIRE

The payer chose to pay using a Carte Bancaire card.

COSTCO_CASH_CARD

The payer chose to pay using a Costco Cash Card (gift card).

COSTCO_PRIVATE_LABEL_CARD

The payer chose to pay using a Costco card.

CRATE_AND_BARREL

The payer chose to pay using a Crate&Barrel card.

DILLARDS_PRIVATE_LABEL_CARD

The payer chose to pay using a Dillards Private Label Card.

DINERS_CLUB

The payer chose to pay using a Diners Club credit card.

DISCOVER

The payer chose to pay using a Discover credit card.

ELO

The payer chose to pay using a ELO card.

ENETS

The payer chose to pay using eNETS.

FARMERS

The payer chose to pay using a Farmers card.

GIROCARD

The payer chose to pay using Girocard.

GIROPAY

The payer chose to pay using giropay (redirect to the payer's online banking).

IDEAL

The payer chose to pay using iDEAL.

JAYWAN

The payer chose to pay using a Jaywan card.

JCB

The payer chose to pay using a JCB credit card.

KLARNA

The payer chose to pay using Klarna.

LASER

The payer chose to pay using a Laser card.

MADA

The payer chose to pay using a mada card.

MAESTRO

The payer chose to pay using a Maestro (debit) card.

MASTERCARD

The payer chose to pay using a Mastercard credit or debit card.

MERCADO_PAGO_CHECKOUT

The payer chose to pay using Mercado Pago Checkout.

MULTIBANCO

The payer chose to pay using Multibanco.

NONE

The transaction transfers money to or from the merchant, without the involvement of a payer. For example, recording monthly merchant service fees from the payment service provider.

OPEN_BANKING_BANK_TRANSFER

The payer choose to pay using Open Banking Bank Transfer.

OXXO

The payer chose to pay using OXXO.

PAGOBANCOMAT

The payer chose to pay using PagoBANCOMAT.

PAYPAK

The payer chose to pay using a PayPak card.

PAYPAL

The payer chose to pay using PayPal.

PBBA

The payer chose to pay using Pay by Bank app.

POLI

The payer chose to pay using POLi.

Q_CARD

The payer chose to pay using a Q-card card.

RUPAY

The payer chose to pay using RuPay.

SEPA

The payer chose to pay using SEPA.

SOFORTBANKING

The payer chose to pay using Sofortbanking.

SORIANA

The payer chose to pay using a Soriana card.

TRUE_REWARDS

The payer chose to pay using a True Rewards card.

UATP

The payer chose to pay using a UATP card.

UNION_PAY

The payer chose to pay using UnionPay SecurePay.

UNKNOWN_CARD

The payer chose to pay using a card, however the card brand could not be determined.

VERVE

The payer chose to pay using a VERVE card.

VISA

The payer chose to pay using a Visa credit or debit card.

VITAMIN_SHOPPE_GIFT_CARD

The payer chose to pay using a Vitamin Shoppe gift card.

WECHAT_PAY

The payer chose to pay using WeChat Pay.

transaction[n].transactionPaymentPlanDeferralNumberOfMonths Numeric CONDITIONAL

The number of months for which the (first) payment is deferred.

transaction[n].transactionPaymentPlanId String CONDITIONAL

The gateway's identifier for the payment plan, for example PLANN, PLANAMEX, CIELO.

transaction[n].transactionPaymentPlanInstallmentAmount Money CONDITIONAL

The amount for each instalment to be made on this payment plan, excluding the initial payment.

The field includes both the amount and currency.

transaction[n].transactionPaymentPlanInterestRate Numeric CONDITIONAL

The interest rate applied to the transaction amount.

transaction[n].transactionPaymentPlanNumberOfInstallments Numeric CONDITIONAL

The number of payments the payer has to make on this payment plan.

transaction[n].transactionPaymentPlanTotalAmount Money CONDITIONAL

The total amount payable on this payment plan, including any interest.

The field includes both the amount and currency.

transaction[n].transactionRiskAssessmentResult Enumeration CONDITIONAL

The overall result of the risk assessment for the transaction.

Value must be a member of the following list. The values are case sensitive.

ACCEPTED

The order was risk assessed and accepted.

NOT_ASSESSED

The order was not risk assessed, apart from the system risk rules and these did not reject the order.

REJECTED

The order was risk assessed and rejected.

REVIEW_REQUIRED

The order was risk assessed and requires a review.

transaction[n].transactionRiskReviewDecisionNote String CONDITIONAL

The reason selected and/or note entered by the merchant when reviewing the transaction or overriding the risk assessment decision.

transaction[n].transactionRiskReviewDecisionStatus Enumeration CONDITIONAL

The status of the risk review for this transaction by the merchant.

Value must be a member of the following list. The values are case sensitive.

ACCEPTED

The order did require a risk review and has been accepted.

NOT_REQUIRED

The order did not require a risk review.

OVERRIDDEN

The order has been rejected by the Risk Service Provider and subsequently accepted by the merchant.

PENDING

The order requires a risk review and is pending a risk review decision.

REJECTED

The order did require a risk review and has been rejected.

transaction[n].transactionRiskReviewDecisionTime Datetime CONDITIONAL

The date and time the merchant reviewed the transaction, if the transaction has been flagged for review as a result of the risk assessment.

transaction[n].transactionRiskReviewDecisionUserId String CONDITIONAL

The user ID of the person that reviewed the transaction when the transaction was flagged for review by the merchant as a result of risk assessment.

transaction[n].transactionRiskRule[n] Array CONDITIONAL

transaction[n].transactionRiskRule[n].description String CONDITIONAL

A string that contains details about the risk rule triggered, including e.g. an identifier for the rule plus the data the rule applied to.

transaction[n].transactionRiskRule[n].outcome String CONDITIONAL

The score or recommendation determined for the transaction after applying this risk rule.

transaction[n].transactionRiskTotalRiskScore Numeric CONDITIONAL

The total of the risk scores for all risk rules applied when assessing the risk for the transaction being fraudulent.

transaction[n].transactionTargetTransactionId String CONDITIONAL

The unique identifier for the target transaction on the gateway.

For example, the identifier of the transaction that was voided or refunded.

transaction[n].transactionTimeOfRecord Datetime CONDITIONAL

The date and time the gateway considers the processing of the transaction to have occurred.

The gateway uses this time as a point-in-time value for operations such as sorting, billing, and reporting.

transaction[n].transactionToken String CONDITIONAL

The token that has been provided for this transaction and used by the gateway to retrieve all or some of the payment details (stored against the token) used for this transaction.

transaction[n].transactionType Enumeration CONDITIONAL

The type of action performed with respect to the order.

For example, Authorization, Capture, Refund.

Value must be a member of the following list. The values are case sensitive.

AUTHENTICATION

A transaction that authenticates the payer.

AUTHORIZATION

A transaction that, if approved, puts a hold on the funds in the payer's account for subsequent capture.

AUTHORIZATION_UPDATE

A transaction that updates an existing Authorization transaction. Usually used to prevent an Authorization from expiring.

CAPTURE

A transaction that captures an Authorization, i.e. moves the funds that were previously put on hold only from the payer's account to the merchant's account.

CHARGEBACK

A transaction that indicates a dispute has been raised by the payer. A dispute can indicate that more information is requested about the transaction or funds have been deducted from the merchant's account.

FUNDING

A transaction that provides details about merchant or event related funding or fee information only.

OTHER

Any other transaction types.

PAYMENT

A transaction that, if approved, moves the funds from the payer's to the merchant's account.

REFUND

A transaction that refunds a payer, i.e. moves funds from the merchant's to the payer's account.

REFUND_REQUEST

A transaction that indicates that a Refund against a Capture transaction has been requested but not yet executed. Further action is required to approve the requested Refund.

VERIFICATION

A transaction that verifies the payer's account exists. No funds are put on hold.

VOID_AUTHORIZATION

A transaction that voids a successful Authorization transaction, i.e. releases the funds that had been put on hold.

VOID_CAPTURE

A transaction that voids a successful Capture transaction, i.e. returns the funds that were previously moved from the payer's to the merchant's account into the payer's account.

VOID_PAYMENT

A transaction that voids a successful Payment transaction i.e. returns the funds that were previously moved from the payer's to the merchant's account into the payer's account.

VOID_REFUND

A transaction that voids a successful Refund transaction i.e. returns the funds that were previously returned from the merchant's to the payer's account into the merchant's account.

transaction[n].transactionUpdate[n] Array CONDITIONAL

transaction[n].transactionUpdate[n].gatewayResponseCode Enumeration CONDITIONAL

The new response gateway code for the transaction after the status change happening at the date and time defined in transactionUpdate.time.

Value must be a member of the following list. The values are case sensitive.

APPROVED

The transaction has been approved.

AUTHENTICATION_IN_PROGRESS

The operation determined that payer authentication is possible for the given card, but this has not been completed, and requires further action by the merchant to proceed.

BLOCKED

The transaction has been blocked as a result of a risk assessment.

CANCELLED

The transaction has been cancelled by the payer.

DECLINED_HARD

The transaction has been declined by the issuer, acquirer or other Payment Service Provider. The merchant must ask the payer for another set of payment details.

DECLINED_SOFT

NOT_SUPPORTED

PARTIALLY_APPROVED

The transaction has been approved, however the approved transaction amount differs from the requested transaction amount.

PENDING_RESPONSE

The gateway has not yet received a response from the acquirer or other Payment Service Provider (e.g. PayPal) about the status of the transaction.

PENDING_SETTLEMENT

PROCESSING_ERROR

REFERRED

UNSPECIFIED_FAILURE

transaction[n].transactionUpdate[n].time Datetime CONDITIONAL

The date and time that the status (responseGatewayCode) of the transaction changed.

transaction[n].userId String CONDITIONAL

The person who initiated the transaction for the merchant, e.g. the logon name of the user submitting the transaction in the gateway's back office.

walletProvider Enumeration CONDITIONAL

The wallet provider used to collect the payer's payment details used for this order.

Value must be a member of the following list. The values are case sensitive.

AMERICAN_EXPRESS_WALLET

The American Express Checkout wallet provider.

APPLE_PAY

The Apple Pay mobile wallet provider.

CHASE_PAY

The Chase Pay wallet provider.

GOOGLE_PAY

The Google Pay mobile wallet provider.

MASTERCARD_WALLET

The Masterpass wallet provider.

SECURE_REMOTE_COMMERCE

The Secure Remote Commerce provider.

VISA_WALLET

The Visa Checkout wallet provider.

walletProviderInteractionId String CONDITIONAL

The wallet provider's unique identifier for the interaction between the payer and the wallet provider's website.

Errors

error



                
        Information on possible error conditions that may occur while processing an operation using the API.


    
            
        
        
            
                
            
            
                
                    
                        
                            error.cause
                            

    
                        Enumeration
                        
                

                
        Broadly categorizes the cause of the error.
        For example, errors may occur due to invalid requests or internal system failures.
        
                
                        
                                        Value must be a member of the following list. The values are case sensitive.
                                        
                                
                                        INVALID_REQUEST
                                        The request was rejected because it did not conform to the API protocol.
                                        
                                
                                        REQUEST_REJECTED
                                        The request was rejected due to security reasons such as firewall rules, expired certificate, etc.
                                        
                                
                                        SERVER_BUSY
                                        The server did not have enough resources to process the request at the moment.
                                        
                                
                                        SERVER_FAILED
                                        There was an internal system failure.
                                        
                                
                
        

        
    
    
        
            
                
            
            
                
                    
                        
                            error.explanation
                            

    
                        String
                        
                

                
        Textual description of the error based on the cause.
        This field is returned only if the cause is INVALID_REQUEST or SERVER_BUSY.
        
                Data can consist of any characters
                
                        Min length:
                                    1
                                Max length:
                                    1000
                                
                
        

        
    
    
        
            
                
            
            
                
                    
                        
                            error.field
                            

    
                        String
                        
                

                
        Indicates the name of the field that failed validation.
        This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
        
                Data can consist of any characters
                
                        Min length:
                                    1
                                Max length:
                                    100
                                
                
        

        
    
    
        
            
                
            
            
                
                    
                        
                            error.supportCode
                            

    
                        String
                        
                

                
        Indicates the code that helps the support team to quickly identify the exact cause of the error.
        This field is returned only if the cause is SERVER_FAILED or REQUEST_REJECTED.
        
                Data can consist of any characters
                
                        Min length:
                                    1
                                Max length:
                                    100
                                
                
        

        
    
    
        
            
                
            
            
                
                    
                        
                            error.validationType
                            

    
                        Enumeration
                        
                

                
        Indicates the type of field validation error.
        This field is returned only if the cause is INVALID_REQUEST and a field level validation error was encountered.
        
                
                        
                                        Value must be a member of the following list. The values are case sensitive.
                                        
                                
                                        INVALID
                                        The request contained a field with a value that did not pass validation.
                                        
                                
                                        MISSING
                                        The request was missing a mandatory field.
                                        
                                
                                        UNSUPPORTED
                                        The request contained a field that is unsupported.


    
        
            
                
            
            
                
                    
                        
                            result
                            

    
                        Enumeration
                        
                

                
        A system-generated high level overall result of the operation.
        
                
                        
                                        Value must be a member of the following list. The values are case sensitive.
                                        
                                
                                        ERROR
                                        The operation resulted in an error and hence cannot be processed.



            
                En esta página


    
        
        
            


   
   
   
   
      
         Resources
         Glosario
         FAQs
      
      
      
         Derechos de autor © 2026 Citigroup Inc.